GET https://api.d-tools.com/SI/Subscribe/ServicePlans?clients[0]={clients[0]}&clients[1]={clients[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&includeImported={includeImported}&searchText={searchText}&includeDeleted={includeDeleted}&pageNumber={pageNumber}&pageSize={pageSize}

Get service plans published by a SI user

Request Information

URI Parameters

Name	Description	Type	Additional information
clients	Clients to filter service plans (Optional)	Collection of string	None.
statuses	Statuses to filter servic plans (Optional)	Collection of string	None.
includeImported	Boolean. Include already imported service plans. Optional with default value false which means by default you will only see service plans which are not imported.	boolean	Default value is False
searchText	The search text.	string	None.
includeDeleted	Boolean. Include servic plan deleted in SI. Optional with default value false which means by default you will only see active servic plans which are not deleted.	boolean	Default value is False
pageNumber	The page number.	integer	Default value is 1
pageSize	The page size.	integer	Default value is 50

Body Parameters

None.

Response Information

Resource Description

ServicePlansResult

Name	Description	Type	Additional information
ServicePlans	Service plans array	Collection of ServicePlanInfo	None.
TotalCount	Total count of service plans	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ServicePlans": [
    {
      "Id": "sample string 1",
      "Client": "sample string 2",
      "Number": "sample string 3",
      "Name": "sample string 4",
      "Status": "sample string 5",
      "Description": "sample string 6",
      "ImportedOn": "2024-04-29T13:44:56.6917687+00:00",
      "PublishedOn": "2024-04-29T13:44:56.6917687+00:00",
      "Deleted": true
    },
    {
      "Id": "sample string 1",
      "Client": "sample string 2",
      "Number": "sample string 3",
      "Name": "sample string 4",
      "Status": "sample string 5",
      "Description": "sample string 6",
      "ImportedOn": "2024-04-29T13:44:56.6917687+00:00",
      "PublishedOn": "2024-04-29T13:44:56.6917687+00:00",
      "Deleted": true
    }
  ],
  "TotalCount": 1
}

application/xml, text/xml

Sample:

<ServicePlansResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <ServicePlans>
    <ServicePlanInfo>
      <Client>sample string 2</Client>
      <Deleted>true</Deleted>
      <Description>sample string 6</Description>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T13:44:56.6917687+00:00</ImportedOn>
      <Name>sample string 4</Name>
      <Number>sample string 3</Number>
      <PublishedOn>2024-04-29T13:44:56.6917687+00:00</PublishedOn>
      <Status>sample string 5</Status>
    </ServicePlanInfo>
    <ServicePlanInfo>
      <Client>sample string 2</Client>
      <Deleted>true</Deleted>
      <Description>sample string 6</Description>
      <Id>sample string 1</Id>
      <ImportedOn>2024-04-29T13:44:56.6917687+00:00</ImportedOn>
      <Name>sample string 4</Name>
      <Number>sample string 3</Number>
      <PublishedOn>2024-04-29T13:44:56.6917687+00:00</PublishedOn>
      <Status>sample string 5</Status>
    </ServicePlanInfo>
  </ServicePlans>
  <TotalCount>1</TotalCount>
</ServicePlansResult>